Refactors to e2e test cases - #413
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Dependency ReviewThe following issues were found:
License Issuespackage-lock.json
package.json
OpenSSF ScorecardScorecard details
Scanned Files
|
There was a problem hiding this comment.
Pull Request Overview
This PR refactors e2e test infrastructure to improve maintainability and reduce hard-coded dependencies. The changes introduce dynamic path generation from a sitemap-based cache, centralize test utilities, and add site-level metadata generation.
Key changes:
- Created a dynamic path system using
.cache/pages.jsongenerated from sitemap data - Centralized e2e helper exports in a single index file
- Removed debug test file and hard-coded TEST_URLS references
- Added sitemap integration with robots.txt support
Reviewed Changes
Copilot reviewed 26 out of 28 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| test/e2e/helpers/baseTest.ts | New extended Playwright test providing dynamic path fixtures from pages.json |
| test/e2e/helpers/index.ts | Centralized exports for e2e test helpers |
| test/e2e/specs/01-smoke/critical-paths.spec.ts | Replaced TEST_URLS with inline path strings and centralized imports |
| test/e2e/specs/01-smoke/site.spec.ts | New site-wide smoke tests for RSS, manifest, and 404 handling |
| test/e2e/specs/02-pages/*.spec.ts | Updated imports from console-errors to consoleErrors (8 files) |
| test/e2e/specs/debug-404s.spec.ts | Removed debug utility file |
| src/lib/config/sitemap-serialize.ts | New sitemap serializer that generates pages.json cache |
| astro.config.ts | Added sitemap integration and pages.json writer hook |
| src/pages/robots.txt.ts | New robots.txt API route |
| vitest.config.ts | Added test paths for new helper tests |
| package.json | Added @astrojs/sitemap dependency |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| * ``` | ||
| */ | ||
| import { test as baseTest, expect } from '@playwright/test' | ||
| import pagesData from '../../../.cache/pages.json' with { type: 'json' } |
There was a problem hiding this comment.
The import path assumes .cache/pages.json exists at build time, but this file is generated during the Astro build process. If tests run before the first build, this import will fail. Consider adding error handling or documentation about running the build first, or dynamically check for the file's existence.
| import fixtureData from '@test/e2e/helpers/__fixtures__/pages.json' | ||
|
|
||
| // Mock the pages.json import | ||
| vi.mock('.cache/pages.json', () => ({ |
There was a problem hiding this comment.
The mock path '.cache/pages.json' is relative and doesn't match the actual import path '../../../.cache/pages.json' used in baseTest.ts. This mock will not intercept the import correctly. The path should be '../../../.cache/pages.json' or an absolute path from the project root.
Suggested change
| vi.mock('.cache/pages.json', () => ({ | |
| vi.mock('../../../.cache/pages.json', () => ({ |
| import type { SitemapItem } from '@astrojs/sitemap' | ||
|
|
||
| // Accumulator for pages data | ||
| const pagesData: Record<string, string[] | true> = {} |
There was a problem hiding this comment.
Using true as a sentinel value alongside string arrays makes the type union confusing. Consider using a more explicit structure like Record<string, { isSingle: boolean; slugs?: string[] }> or separate the single pages from multi-level pages into different data structures for better type safety.
| `) | ||
| }) | ||
|
|
||
| it('should extract all pages', () => { |
There was a problem hiding this comment.
Double space between 'all' and 'pages' should be a single space.
Suggested change
| it('should extract all pages', () => { | |
| it('should extract all pages', () => { |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Type of Change
Changes Made
Related Issues
Closes #
Testing
npm run test:unit)npm run test:e2e:ready)npm run lint)npm run build)Screenshots (if applicable)
Checklist
Additional Notes